home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / docshell / nsIEditorDocShell.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-05-08  |  4.8 KB  |  149 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIEditorDocShell.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIEditorDocShell_h__
  6. #define __gen_nsIEditorDocShell_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIEditor; /* forward declaration */
  18.  
  19.  
  20. /* starting interface:    nsIEditorDocShell */
  21. #define NS_IEDITORDOCSHELL_IID_STR "3bdb8f01-f141-11d4-a73c-fba4aba8a3fc"
  22.  
  23. #define NS_IEDITORDOCSHELL_IID \
  24.   {0x3bdb8f01, 0xf141, 0x11d4, \
  25.     { 0xa7, 0x3c, 0xfb, 0xa4, 0xab, 0xa8, 0xa3, 0xfc }}
  26.  
  27. /**
  28.  * nsIEditorDocShell provides a way to get an editor from
  29.  * a specific frame in a docShell hierarchy. It is intended
  30.  * to be only used internally. Use nsIEditingShell.getEditorForFrame
  31.  * from out side.
  32.  */
  33. class NS_NO_VTABLE nsIEditorDocShell : public nsISupports {
  34.  public: 
  35.  
  36.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IEDITORDOCSHELL_IID)
  37.  
  38.   /* attribute nsIEditor editor; */
  39.   NS_IMETHOD GetEditor(nsIEditor * *aEditor) = 0;
  40.   NS_IMETHOD SetEditor(nsIEditor * aEditor) = 0;
  41.  
  42.   /* readonly attribute boolean editable; */
  43.   NS_IMETHOD GetEditable(PRBool *aEditable) = 0;
  44.  
  45.   /* readonly attribute boolean hasEditingSession; */
  46.   NS_IMETHOD GetHasEditingSession(PRBool *aHasEditingSession) = 0;
  47.  
  48.   /**
  49.      * Make this docShell editable, setting a flag that causes
  50.      * an editor to get created, either immediately, or after
  51.      * a url has been loaded.
  52.      *      @param  inWaitForUriLoad    true to wait for a URI before
  53.      *                                  creating the editor.
  54.      */
  55.   /* void makeEditable (in boolean inWaitForUriLoad); */
  56.   NS_IMETHOD MakeEditable(PRBool inWaitForUriLoad) = 0;
  57.  
  58. };
  59.  
  60. /* Use this macro when declaring classes that implement this interface. */
  61. #define NS_DECL_NSIEDITORDOCSHELL \
  62.   NS_IMETHOD GetEditor(nsIEditor * *aEditor); \
  63.   NS_IMETHOD SetEditor(nsIEditor * aEditor); \
  64.   NS_IMETHOD GetEditable(PRBool *aEditable); \
  65.   NS_IMETHOD GetHasEditingSession(PRBool *aHasEditingSession); \
  66.   NS_IMETHOD MakeEditable(PRBool inWaitForUriLoad); 
  67.  
  68. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  69. #define NS_FORWARD_NSIEDITORDOCSHELL(_to) \
  70.   NS_IMETHOD GetEditor(nsIEditor * *aEditor) { return _to GetEditor(aEditor); } \
  71.   NS_IMETHOD SetEditor(nsIEditor * aEditor) { return _to SetEditor(aEditor); } \
  72.   NS_IMETHOD GetEditable(PRBool *aEditable) { return _to GetEditable(aEditable); } \
  73.   NS_IMETHOD GetHasEditingSession(PRBool *aHasEditingSession) { return _to GetHasEditingSession(aHasEditingSession); } \
  74.   NS_IMETHOD MakeEditable(PRBool inWaitForUriLoad) { return _to MakeEditable(inWaitForUriLoad); } 
  75.  
  76. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  77. #define NS_FORWARD_SAFE_NSIEDITORDOCSHELL(_to) \
  78.   NS_IMETHOD GetEditor(nsIEditor * *aEditor) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetEditor(aEditor); } \
  79.   NS_IMETHOD SetEditor(nsIEditor * aEditor) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetEditor(aEditor); } \
  80.   NS_IMETHOD GetEditable(PRBool *aEditable) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetEditable(aEditable); } \
  81.   NS_IMETHOD GetHasEditingSession(PRBool *aHasEditingSession) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetHasEditingSession(aHasEditingSession); } \
  82.   NS_IMETHOD MakeEditable(PRBool inWaitForUriLoad) { return !_to ? NS_ERROR_NULL_POINTER : _to->MakeEditable(inWaitForUriLoad); } 
  83.  
  84. #if 0
  85. /* Use the code below as a template for the implementation class for this interface. */
  86.  
  87. /* Header file */
  88. class nsEditorDocShell : public nsIEditorDocShell
  89. {
  90. public:
  91.   NS_DECL_ISUPPORTS
  92.   NS_DECL_NSIEDITORDOCSHELL
  93.  
  94.   nsEditorDocShell();
  95.  
  96. private:
  97.   ~nsEditorDocShell();
  98.  
  99. protected:
  100.   /* additional members */
  101. };
  102.  
  103. /* Implementation file */
  104. NS_IMPL_ISUPPORTS1(nsEditorDocShell, nsIEditorDocShell)
  105.  
  106. nsEditorDocShell::nsEditorDocShell()
  107. {
  108.   /* member initializers and constructor code */
  109. }
  110.  
  111. nsEditorDocShell::~nsEditorDocShell()
  112. {
  113.   /* destructor code */
  114. }
  115.  
  116. /* attribute nsIEditor editor; */
  117. NS_IMETHODIMP nsEditorDocShell::GetEditor(nsIEditor * *aEditor)
  118. {
  119.     return NS_ERROR_NOT_IMPLEMENTED;
  120. }
  121. NS_IMETHODIMP nsEditorDocShell::SetEditor(nsIEditor * aEditor)
  122. {
  123.     return NS_ERROR_NOT_IMPLEMENTED;
  124. }
  125.  
  126. /* readonly attribute boolean editable; */
  127. NS_IMETHODIMP nsEditorDocShell::GetEditable(PRBool *aEditable)
  128. {
  129.     return NS_ERROR_NOT_IMPLEMENTED;
  130. }
  131.  
  132. /* readonly attribute boolean hasEditingSession; */
  133. NS_IMETHODIMP nsEditorDocShell::GetHasEditingSession(PRBool *aHasEditingSession)
  134. {
  135.     return NS_ERROR_NOT_IMPLEMENTED;
  136. }
  137.  
  138. /* void makeEditable (in boolean inWaitForUriLoad); */
  139. NS_IMETHODIMP nsEditorDocShell::MakeEditable(PRBool inWaitForUriLoad)
  140. {
  141.     return NS_ERROR_NOT_IMPLEMENTED;
  142. }
  143.  
  144. /* End of implementation class template. */
  145. #endif
  146.  
  147.  
  148. #endif /* __gen_nsIEditorDocShell_h__ */
  149.